/*
 * MIT License
 *
 * Copyright (c) 2020 wen.gu <454727014@qq.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/***************************************************************************
 * Name: execution_client.h
 *
 * Purpose: The Execution State API provides the functionality for a Process 
 *          to report its state to the Execution Management
 *
 * Developer:
 *   wen.gu , 2020-04-20
 *
 * TODO:
 *
 ***************************************************************************/

#ifndef __ARA_EXEC_EXECUTION_CLIENT_H__
#define __ARA_EXEC_EXECUTION_CLIENT_H__
/******************************************************************************
 **    INCLUDES
 ******************************************************************************/

#include <cstdint>
#include <memory>

#include "ara/core/result.h"
/******************************************************************************
 **    MACROS
 ******************************************************************************/


/******************************************************************************
 **    TYPE DEFINITIONS
 ******************************************************************************/
namespace ara
{
namespace exec
{
enum class ExecutionState : uint8_t
{
    kRunning = 0, /** After a Process has been started by Execution
                   *  Management, it reports ExecutionState kRunning */
    kTerminating = 1, /** On receipt of SIGTERM, a Reporting Process
                        * acknowledges the request (by reporting k
                        * Terminating to Execution Management*/

};
/******************************************************************************
 **    CLASSES/FUNCTIONS DEFINITIONS
 ******************************************************************************/

/** Class to implement operations on Execution Client */
class ExecutionClient final
{
public:
    ExecutionClient() noexcept;
    ~ExecutionClient() noexcept;

public:
    ara::core::Result<void> ReportExecutionState(ExecutionState state)  const noexcept;

private: /** internal implementation this class,e.g special system platform imeplementaiton */
    class impl;
    std::unique_ptr<impl> mImpl;
};


} /** namespace exec */
} /** namespace ara */

#endif /** !__ARA_EXEC_EXECUTION_CLIENT_H__ */

